package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.ApplyToProgLevelAddDTO;
import org.jsola.hr.dto.ApplyToProgLevelUpdateDTO;
import org.jsola.hr.query.ApplyToProgLevelQuery;
import org.jsola.hr.vo.ApplyToProgLevelListVO;
import org.jsola.hr.vo.ApplyToProgLevelVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-方案适用设置职级")
public interface IApplyToProgLevelControllerAPI {

    /**
     * 新增方案适用设置职级
     * @param applyToProgLevelAddDTO 方案适用设置职级新增实体
     * @return 方案适用设置职级展示对象
     */
    @ApiOperation(value = "新增方案适用设置职级")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgLevelAddDTO", dataType = "ApplyToProgLevelAddDTO", value = "新增方案适用设置职级", paramType = "body")
    })
    Result<ApplyToProgLevelVO> save(ApplyToProgLevelAddDTO applyToProgLevelAddDTO);


    /**
     * 修改方案适用设置职级
     * @param applyToProgLevelUpdateDTO 方案适用设置职级
     * @return 更新数量
     */
    @ApiOperation(value = "修改方案适用设置职级")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgLevelUpdateDTO", dataType = "ApplyToProgLevelUpdateDTO", value = "修改方案适用设置职级", paramType = "body")
    })
    Result<Integer> update(ApplyToProgLevelUpdateDTO applyToProgLevelUpdateDTO);




    /**
     * 删除单个方案适用设置职级，彻底删除
     * @param applyToProgLevelId 方案适用设置职级id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个方案适用设置职级，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgLevelId", dataType = "String", value = "方案适用设置职级id", paramType = "path")
    })
    Result<Integer> delete(String applyToProgLevelId);


    /**
     * 批量删除方案适用设置职级，彻底删除
     * @param applyToProgLevelIds 方案适用设置职级id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除方案适用设置职级，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgLevelIds", dataType = "String[]", value = "方案适用设置职级id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] applyToProgLevelIds);


    /**
     * 根据方案适用设置职级id查询方案适用设置职级详情
     * @param applyToProgLevelId 方案适用设置职级id
     * @return 方案适用设置职级详情
     */
    @ApiOperation(value="根据方案适用设置职级id查询方案适用设置职级详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgLevelId", dataType = "String", value = "方案适用设置职级id", paramType = "path")
    })
    Result<ApplyToProgLevelVO> findById(String applyToProgLevelId);


    /**
     * 查询方案适用设置职级
     * @param applyToProgLevelQuery 方案适用设置职级查询参数
     * @return page
     */
    @ApiOperation(value="查询方案适用设置职级")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgLevelQuery", dataType = "ApplyToProgLevelQuery", value = "方案适用设置职级查询参数", paramType = "query")
    })
    Result<List<ApplyToProgLevelListVO>> listAll(ApplyToProgLevelQuery applyToProgLevelQuery);


     /**
     * 分页查询方案适用设置职级
     * @param applyToProgLevelQuery 方案适用设置职级查询参数
     * @return page
     */
    @ApiOperation(value="分页查询方案适用设置职级")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgLevelQuery", dataType = "ApplyToProgLevelQuery", value = "方案适用设置职级查询参数", paramType = "query")
    })
    Result<Page<ApplyToProgLevelListVO>> page(ApplyToProgLevelQuery applyToProgLevelQuery);


}

